rehype-minify-whitespace

What is rehype-minify-whitespace?

The rehype-minify-whitespace package is a plugin for the rehype ecosystem that minifies whitespace in HTML. It helps in reducing the size of HTML files by removing unnecessary whitespace, which can improve load times and overall performance.

What are rehype-minify-whitespace's main functionalities?

Minify Whitespace

This feature minifies the whitespace in the provided HTML string. In the example, the excessive spaces between 'Hello' and 'World' are removed.

const rehype = require('rehype');
const minifyWhitespace = require('rehype-minify-whitespace');

rehype()
  .use(minifyWhitespace)
  .process('<div>   Hello   World   </div>', function (err, file) {
    if (err) throw err;
    console.log(String(file));
  });

Other packages similar to rehype-minify-whitespace

html-minifier

html-minifier is a highly configurable, full-featured HTML minifier. It offers more extensive options for minifying HTML, including removing comments, collapsing whitespace, and minifying CSS and JavaScript within the HTML. Compared to rehype-minify-whitespace, it provides a broader range of minification options but may be more complex to configure.

clean-css

clean-css is a fast and efficient CSS optimizer for Node.js. While it focuses on CSS, it can be used in conjunction with HTML minification tools to achieve comprehensive minification. It complements rehype-minify-whitespace by handling CSS minification, which rehype-minify-whitespace does not cover.

uglify-js

uglify-js is a JavaScript parser, minifier, compressor, and beautifier toolkit. It is used to minify JavaScript code, which can be part of the overall minification process for web assets. While it does not directly compete with rehype-minify-whitespace, it is often used alongside HTML minifiers to reduce the size of JavaScript files.

README

rehype-minify-whitespace

rehype plugin to minify whitespace between elements.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(rehypeMinifyWhitespace[, options])
• Example
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package is a plugin that can minify the whitespace between elements.

When should I use this?

You can use this plugin when you want to improve the size of HTML documents.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install rehype-minify-whitespace

In Deno with Skypack:

import rehypeMinifyWhitespace from 'https://cdn.skypack.dev/rehype-minify-whitespace@5?dts'

In browsers with Skypack:

<script type="module">
  import rehypeMinifyWhitespace from 'https://cdn.skypack.dev/rehype-minify-whitespace@5?min'
</script>

Use

On the API:

import {read} from 'to-vfile'
import {unified} from 'unified'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import rehypeMinifyWhitespace from 'rehype-minify-whitespace'

main()

async function main() {
  const file = await unified()
    .use(rehypeParse)
    .use(rehypeMinifyWhitespace)
    .use(rehypeStringify)
    .process(await read('index.html'))

  console.log(String(file))
}

On the CLI:

rehype input.html --use rehype-minify-whitespace --output output.html

On the CLI in a config file (here a package.json):

 …
 "rehype": {
   "plugins": [
     …
+    "rehype-minify-whitespace",
     …
   ]
 }
 …

API

This package exports no identifiers. The default export is rehypeMinifyWhitespace.

unified().use(rehypeMinifyWhitespace[, options])

Minify whitespace.

options

Configuration (optional).

options.newlines

Whether to collapse runs of whitespace that include line endings to one line ending (boolean, default: false). The default is to collapse everything to one space.

Example

In

<h1>Heading</h1>
<p><strong>This</strong> and <em>that</em></p>

Out

<h1>Heading</h1><p><strong>This</strong> and <em>that</em></p>

Syntax

HTML is handled according to WHATWG HTML (the living standard), which is also followed by browsers such as Chrome and Firefox.

Syntax tree

The syntax tree format used is hast.

Types

This package is fully typed with TypeScript.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

As rehype works on HTML, and improper use of HTML can open you up to a cross-site scripting (XSS) attack, use of rehype can also be unsafe. Use rehype-sanitize to make the tree safe.

Contribute

See contributing.md in rehypejs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer